/*===========================================================================*/
/**
 * @file template.c
 *
 * @todo Add a one line description of the implementation.
 *
 *------------------------------------------------------------------------------
 *
 * Copyright (C) 2025 XIANZHIGONG. All rights reserved. 
 * XIANZHIGONG Sensitve Business - Restricted XIANZHIGONG information. Do not disclose
 *
 *------------------------------------------------------------------------------
 *
 * @section DESC DESCRIPTION:
 *
 * @todo Add full description here
 *
 * @section ABBR ABBREVIATIONS:
 *   - @todo List any abbreviations, precede each with a dash ('-').
 *
 * @section TRACE TRACEABILITY INFO:
 *   - Design Document(s):
 *     - @todo Update list of design document(s).
 *
 *   - Requirements Document(s):
 *     - @todo Update list of requirements document(s)
 *
 *   - Applicable Standards (in order of precedence: highest first):
 *     - ESGW_4-2_PE-SWx_00-01-A02_EN - C Coding Standards [20120506]
 *     - @todo Update list of other applicable standards
 *
 * @section DFS DEVIATIONS FROM STANDARDS:
 *   - @todo List of deviations from standards in this file, or "None".
 *
 * @ updates to areas outside the scope of procedures:
 *   - Refer to module footer comment block.
 */
/*==========================================================================*/

/*===========================================================================*
 * Standard Header Files
 *===========================================================================*/
/* - @todo Header files that are common across an entire program or project
 and ANSI C standard library header files. */
/* - @todo Preprocessor #include directive(s) for standard header files */
/* - @todo https://google.github.io/styleguide/cppguide.html */
#if 0

/* Source file's associated header file */
#include "template.h"

/* C system headers (more precisely: headers in angle brackets with the .h extension), e.g., <unistd.h>, <stdlib.h>. */
#include <sys/types.h>
#endif /* #if 0 */

/*===========================================================================*
 * Other Header Files
 *===========================================================================*/
/* - @todo Header files that are required by a particular file (all header
 files that are not "standard header files"). */
/* - @todo Preprocessor #include directive(s) for other header files */

#if 0
/* Other libraries' .h files. */
#include <F021_F28003x_C28x.h>

/* Project's .h files. */
#include "base/basictypes.h"
#include "third_party/absl/flags/flag.h"
#include "features/example_other_header.h"
#endif /* #if 0 */

/*===========================================================================*
 * Local Preprocessor #define Constants
 *===========================================================================*/
/* - @todo Local preprocessor #define constants (object-like macros) shall be all upper case delimited with underscores.*/
#if 0
#define EXAMPLE_MY_ANSWER ((uint8_t)42)
#endif /* #if 0 */

/*===========================================================================*
 * Local Preprocessor #define MACROS
 *===========================================================================*/
/* Local preprocessor #define macros (i.e., those using # or ## operator) */
/* [N6] All preprocessor #define macros shall be all upper case delimited with underscores. */
#if 0
#define EXAMPLE_MAKE_STRING(x) #x
#include EXAMPLE_MAKE_STRING(myheader.h)
#endif /* #if 0 */

/*===========================================================================*
 * Local Type Declarations
 *===========================================================================*/
/* Local type declarations (enum, struct, union, typedef) */
/* N4] All user type definitions shall be mixed case, delimited with underscores, and end with _T suffix. */
#if 0
typedef uint8_t Example_Vehicle_Speed_T;
typedef struct Example_Point_3D_Tag
{
   uint8_t x;
   uint8_t y;
   uint8_t z;
}
Example_Point_3D_T;
#endif /* #if 0 */

/*===========================================================================*
 * Exported Object Definitions
 *===========================================================================*/
/* [N1.1] All file scope objects shall be mixed case delimited with underscores. */
#if 0
uint8_t Example_My_Global_Variable = 0;
/* Add "extern uint8_t My_Global_Variable;" in header file*/

Point_2D_T My_Points[MAX_POINTS] = {0};

#endif /* #if 0 */

/*===========================================================================*
 * Local Object Definitions
 *===========================================================================*/
/* [N1.1] All file scope objects shall be mixed case delimited with underscores. */
#if 0
static uint8_t Example_My_Internal_Variable = 0;
#endif /* #if 0 */

/*===========================================================================*
 * Local Function Prototypes
 *===========================================================================*/
/* [N3] All functions shall be mixed case and delimited with underscores */
#if 0
static void My_Internal_Function(void);
#endif /* #if 0 */

/*===========================================================================*
 * Local Inline Function Definitions and Function-Like Macros
 *===========================================================================*/
/* Local Inline Function Definitions*/
#if 0
static void My_Internal_Inline_Function(void)
{
}
#endif /* #if 0 */

#if 0
/* Function-Like Macros */
#define Double(x) (2 * (x))
#endif /* #if 0 */


/*===========================================================================*
 * Function Definitions
 *===========================================================================*/
/* Local and global functions */
#if 0
/******************************************************************************
* Name:  My_Internal_Function
*   This function blah blah blah
*
* Shared Variables: none
*
* Parameters: none
*
* Return Value: none
*
* Design Information:
*  - reference design document
*
*  Change References:
*  - list change numbers
*
* Add Polarion Work Item Link to the intended line (if using Resource Link  
* for traceability)
* Syntax: 
* @wi.<LinkRoleAsSingleWord> <PolarionProjectID>/<workitemID>
* example:
* @wi.implemented PDP2.0_playground/WI-5001
*
******************************************************************************/
static void My_Internal_Function(void)
{
   x  x  x  x  x  x  <<= Indents every 3 chars
} /* end My_Internal_Function */
#endif /* #if 0 */

#if 0
/* "extern void My_External_Function(void);" shall be in header file. */
/* Consider moving description to the header file */
/******************************************************************************
* Name:  My_External_Function
*   This function perform MCD self test
*
* Parameters:
*  - none
*
* Return:
*  - 0 Pass
*  - 1 Fail
*
* Quoted Variables:
*  - g_u16_NMI_Status
*
* Modified Variables:
*  - g_unMcdErrStatus
*  - g_u16_NMI_Isr_Flag
*  - g_u16_NMI_Status
*  - ClkCfgRegs
*
* Called Functions:
*  - SysCtl_getClock
*  - EALLOW
*  - HWREGH
*  - EDIS
*  - BSW_MCAL_SysClockInit
*
* Design Information:
*  - C2000Ware sdl_ex_mcd_test.html
*
*  Change References:
*  - v0 initial version
*
* @todo
* @wi.implemented POLESTAR_DCDC/TBD-xxxx
*
******************************************************************************/
void My_External_Function( void )
{
   x  x  x  x  x  x  <<= Indents every 3 chars
} /* end My_External_Function */

#endif /* #if 0 */

/*============================================================================*\
 * AUTHOR(S) IDENTITY (AID)                                                     
 *-----------------------------------------------------------------------------  
 *                                     
 *  AID         NAME                 User ID
 *  ---------------------------------------------------------------------------
 *  XXX         Firstname Lastname   njp4bz
 *  XG          Xianzhi Gong         njp4bz
 *  HL          Herbert Langley                        
\*============================================================================*/

/*============================================================================*\
 * FILE REVISION HISTORY - To be filled by the project team                                               
 *-----------------------------------------------------------------------------  
 *                                     
 *  DATE               REVISION    AID          JIRA Ticket ID/SUMMARY OF CHANGES                                 
 *  ---------------------------------------------------------------------------
 *  May 28, 2025       1.00        XXX          12345        
 *                                        
 *  ---------------------------------------------------------------------------
\*============================================================================*/

/* END OF FILE -------------------------------------------------------------- */

